home *** CD-ROM | disk | FTP | other *** search
/ Over 1,000 Windows 95 Programs / Over 1000 Windows 95 Programs (Microforum) (Disc 1).iso / 0153 / rteduser.prn < prev    next >
Encoding:
Text File  |  1997-03-25  |  39.3 KB  |  1,180 lines

  1.  
  2.  
  3.  
  4.                            RT Edit User's Manual
  5.  
  6.  
  7.  
  8.                              TABLE OF CONTENTS
  9.  
  10. INTRODUCTION                         1
  11. INSTALLATION                         2
  12. REQUIREMENTS                         2
  13. CAPABILITIES                         3
  14.   Identifier Lookup Window           3
  15.   Identifier Lookup Keys             3
  16.   SetupRT Controls                   3
  17.   Save and Restore Environment       3
  18. LIMITATIONS                          4
  19.   Name Prefix Limitations            4
  20.   Word length                        4
  21.   Use for draft code                 4
  22.   File Size                          4
  23.   Cascaded Windows                   4
  24. RT EDIT OPERATION                    5
  25.   Overview                           5
  26.   Starting RT Edit                   5
  27.   SetupRT                            6
  28.   Select File Name                   6
  29.   Select Header Options              6
  30.   Select Source Directory            7
  31.   Select Header Directories          7
  32.   Set Font                           7
  33.   Initiate Identifier Lookup         7
  34.   Save Environment                   7
  35.   Select Edit File                   7
  36.   Known Identifier Check             7
  37.   Terminate Identifier Lookup        8
  38.   Restore Environment                8
  39.   Restart Identifier Lookup          8
  40.   Test Edit                          8
  41.   Insert new variable name           8
  42.   Insert Known Variable name         8
  43. ALTERNATIVE SETUP                    9
  44. IDENTIFIER SEARCHING TACTICS        10
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                   Page i
  64.  
  65.  
  66.                            RT Edit User's Manual
  67.  
  68.  
  69. RT EDIT HELP                        11
  70.   Introduction                      11
  71.   SetupRT | Identifier Lookup       11
  72.   SetupRT | Set File Name           12
  73.   SetupRT | Use Headers On          12
  74.   SetupRT | Expanded Search         12
  75.   SetupRT | Suspend Lookup          12
  76.   SetupRT | Source Directory        12
  77.   SetupRT | Header Directories      13
  78.   SetupRT | Set Font                13
  79.   SetupRT | Restore Environment     13
  80.   SetupRT | Save Environment        13
  81.   SetupRT | Auto Indent On          13
  82. SHAREWARE                           15
  83. SUPPORT                             16
  84. ASP OMBUDSMAN                       16
  85. LICENSE, WARRANTY AND REGISTRATION  17
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.                                   Page ii
  126.  
  127.  
  128.                            RT Edit User's Manual
  129.  
  130.  
  131.  
  132. Introduction
  133.  
  134.   RT Edit is an editor that creates a spell check dictionary based on your
  135.   source code and built-in headers. This editor can help you in draft
  136.   creation of new code or for adding segments of code to a module.  RT
  137.   Edit runs in Windows and uses OWL components.
  138.  
  139.   RT Edit assists you via a module called Identifier Lookup. Identifier
  140.   Lookup builds a dictionary of the identifier names you have already
  141.   created or that exist in library headers you intend to use.  As you type
  142.   in your code (more than four characters of an identifier) Identifier
  143.   Lookup lists candidate matches in a separate window.  If you are typing
  144.   in a previously defined identifier, you may elect to have one of the
  145.   listed names substituted for the text you have typed thus far.  If the
  146.   identifier is instead a new one, completing the name by entering a non-
  147.   identifier character will cause Identifier Lookup to store the new name.
  148.   Keeping up with matches to your typing occurs in near real time provided
  149.   the dictionary is not so large that disk accesses begin to cause your
  150.   system to thrash.
  151.  
  152.   The Identifier Lookup capability works on the first few characters of
  153.   your identifiers and does not care if you mix them up or leave out some
  154.   of the beginning.   However, this does nothing for you when you only
  155.   recall some piece in the middle or the end of one of your identifiers.
  156.   Expanded Search allows you to enter just a segment of the middle and get
  157.   a list of all the identifiers ordered by a ranked degree of closeness to
  158.   that segment.
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.                                   Page 1
  188.  
  189.  
  190.                            RT Edit User's Manual
  191.  
  192.  
  193.  
  194. Installation
  195.  
  196.   Run the Setup File from Windows.  One way to do this is to use the
  197.   Program Manager.  Select File | Run, then enter D:\Setup replacing "D"
  198.   with the disk drive where RT Edit resides or the full path to the RT
  199.   Files on your hard disk.
  200.  
  201.   You will see an introductory prompt.  At this point, you may cancel the
  202.   installation or continue.  At several points in the process, you may
  203.   choose "Exit" to terminate the installation.  If you do so, the
  204.   installation will be incomplete.
  205.  
  206.   If you continue, you will then see a Directory Prompt dialog with a
  207.   prompt to accept or change the directory.
  208.  
  209.   A dialog then prompts for your selection of optional items available in
  210.   the installation.  Two versions of the User's Manual on disk are
  211.   provided.  One is in Microsoft Word for Windows format, a file with .doc
  212.   extension, the other is an ASCII text file, extension .txt.
  213.  
  214.   If there is not enough space on the destination drive, you  will see a
  215.   prompt to fix or ignore the problem.
  216.  
  217.   You will then see a group prompt and be asked to accept the group name
  218.   provided or to select an existing group,  or enter a new one.
  219.  
  220.   If later information is available than provided in the User's Manual, a
  221.   Read Me  dialog will load and display.  When you exit the Read Me
  222.   dialog, the installation is complete and you may exit the setup program.
  223.  
  224.  
  225.  
  226.  
  227. Requirements
  228.  
  229.   To use RT Edit, your system must have:
  230.  
  231.      - At least a 386. A 486 or better recommended.
  232.      - Windows 3.1 or higher running in 386 enhanced mode.
  233.      - A hard disk with 1 MB of available disk space.
  234.      - A 1.44 MB floppy drive (installation of the registered version).
  235.      - At least 4 MB of extended memory. Preferably 8 MB or greater.
  236.      - A Windows compatible mouse.
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.                                   Page 2
  250.  
  251.  
  252.                            RT Edit User's Manual
  253.  
  254.  
  255.  
  256. Capabilities
  257.  
  258.   You will find the general capabilities of RT Edit in the following.  You
  259.   will not find the general capabilities of the Windows MDI Editor in this
  260.   document but on-line Help is available.  For help with the general
  261.   editing  operations, refer to the on-line help.
  262.  
  263.   Identifier Lookup Window
  264.  
  265.      A different type of child window shows matches to your existing
  266.      identifiers when appropriate.  It is appropriate when:
  267.         -  You enabled Identifier Lookup..
  268.         -  You have typed four or more characters.
  269.         -  Identifier Lookup found at least one Candidate Identifier
  270.                match during the search.
  271.  
  272.  
  273.   Identifier Lookup Keys
  274.  
  275.      Note that the keys identified in this section operate the same whether
  276.      you also press SHIFT or not.  So you may, if you prefer, think of the
  277.      unshifted versions of the keys listed, that is, CTRL+(, . or /).  In
  278.      no case do you need to press the SHIFT key also.
  279.  
  280.      If the Identifier Lookup lists multiple candidates in the Window, the
  281.      CTRL+< key combination will move the selection up in the list and the
  282.      CTRL-> key will move the selection down in the list.  The selection
  283.      wraps around to the bottom of the list if you move up past the first
  284.      item. The selection wraps around to the top of the list if you move
  285.      down past the last item in the list.
  286.  
  287.      When a name selected in the Identifier Lookup window is one you want
  288.      to substitute for the partial variable you have typed so far, the
  289.      CTRL+? key combination will replace the fragment you have typed with
  290.      the selection.
  291.  
  292.   SetupRT Controls
  293.  
  294.      RT Edit includes several controls for the setup of Identifier Lookup
  295.      operations.  There are controls to determine the extent of processing
  296.      for the associated header files for a module.  There are controls to
  297.      identify paths for header file searching and a different source
  298.      directory.  There are controls for suspending, stopping and restarting
  299.      the use of Identifier Lookup.
  300.  
  301.   Save and Restore Environment
  302.  
  303.      RT Edit includes the capability to save the settings that control the
  304.      SetupRT operation.  You can use the default file name but since
  305.      several different files may be useful for working on different
  306.      modules, you may want to provide your own file name instead.
  307.  
  308.      You may restore the SetupRT controls from the default file or from the
  309.      file of your choice.
  310.  
  311.                                   Page 3
  312.  
  313.  
  314.                            RT Edit User's Manual
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323. Limitations
  324.  
  325.   Name Prefix Limitations
  326.  
  327.      At this time, RT Edit's Identifier Lookup is not recommended for code
  328.      with heavy use of a standard prefix notation.  One example is
  329.      Hungarian Notation as described in "Programming Windows 3.1," by
  330.      Charles Petzhold.  It is possible to use Identifier Lookup but it may
  331.      be necessary to type much more of an identifier before you see a good
  332.      match.  Also, the efficiency of Identifier Lookup may be greatly
  333.      impaired in this case.
  334.  
  335.   Word length
  336.  
  337.      Identifier Lookup does not operate on words under 4 characters in
  338.      length.
  339.  
  340.   Use for draft code
  341.  
  342.      Use of RT Edit is recommended for draft creation of code, not for
  343.      formatting or final editing.
  344.  
  345.   File Size
  346.  
  347.      The Editor file size limit is  32K characters for adding text. The
  348.      edit control used is the standard Window Edit Control except for
  349.      slight modification of the buffer provided.  Because of the
  350.      modification you may open a file of size up to about 60K characters
  351.      and may browse it but you may not be able to add more text.
  352.  
  353.   Cascaded Windows
  354.  
  355.      Not more than three edit windows may be Cascaded when Identifier
  356.      Lookup is active.  The Identifier Lookup window will be adjusted to
  357.      fit the area below the lowest edit window.  If there are more than
  358.      three edit windows open and Identifier Lookup is active,  a dialog
  359.      will appear with two choices.  You can abandon the Cascade command or
  360.      abandon Identifier Lookup.   An Identifier Lookup window shrunk to fit
  361.      into the area below four cascaded edit windows is too small to be
  362.      useful.
  363.  
  364.  
  365.  
  366.  
  367.  
  368.  
  369.  
  370.  
  371.  
  372.  
  373.                                   Page 4
  374.  
  375.  
  376.                            RT Edit User's Manual
  377.  
  378.  
  379.  
  380. RT Edit Operation
  381.  
  382.   Overview
  383.  
  384.      RT Edit is not a complex editor, based as it is on a Windows Edit
  385.      Control. The Identifier Lookup capability initially creates a spell-
  386.      lookup dictionary of the identifiers you have used in your C++ module.
  387.      During editing, Identifier Lookup adds to the dictionary automatically
  388.      in real time as you create new names. Also, a list of matching names
  389.      is displayed as you type more than four characters of an identifier.
  390.      When there are matching identifiers displayed in the window provided,
  391.      you have the ability to pick a substitute for what you typed so far.
  392.      Identifier Lookup assists use of long identifier names often used for
  393.      self documenting code purposes.  Identifiers shorter than four
  394.      characters are not stored in the dictionary..  Because programmers are
  395.      so familiar with reserved words these are not looked-up either.
  396.  
  397.      RT Edit provides the capability to select files by name for Identifier
  398.      Lookup processing.  This allows tailoring Identifier Lookup to work
  399.      with a particular module.  For example, you may specify both the
  400.      ".CPP" (or equivalent extension) file and it's associated header file
  401.      to Identifier Lookup.  Moreover, you may select automatic use of
  402.      header files identified in "#include" statements.  When you choose to
  403.      start Identifier Lookup, all named files and all include files, if
  404.      selected, are searched for legal C/C++ names greater than 4 but under
  405.      33 characters in length.  Reserved words, names less than four
  406.      characters, words within comments or words within strings are not
  407.      loaded.  The files you use should thus correctly match begin and end
  408.      comment symbols before you start Identifier Lookup.  In addition,
  409.      quoted strings should also correctly match begin and end quotes.
  410.  
  411.  
  412.      Identifier Lookup ignores names less than a minimum length of four
  413.      characters.  The reason for this is that short identifiers are not the
  414.      target for Identifier Lookup support. For example, Identifier Lookup
  415.      does not help using  short variable names such as "i", "j", or fixing
  416.      "teh" to "the."  However, Identifier Lookup presents a list of longer
  417.      names after typing four or more characters.  The list accounts for
  418.      possible errors in the first few characters.  One error is omission of
  419.      one letter, for example,  typing "nume" when the goal is to type
  420.      "numberOfVowelsInSentence." Another error is transposition of letters,
  421.      for example,  typing "nmue."  Identifier Lookup will not display a
  422.      candidate identifier  unless at least two of the typed characters are
  423.      also contained in the candidate.
  424.  
  425.  
  426.   Starting RT Edit
  427.  
  428.      You start RT Edit as a stand-alone task by any standard Windows
  429.      method, such as double-clicking the icon in whatever program group you
  430.      used in installation.  You could setup the program to accept an
  431.      argument.  The argument RT Edit will accept is a file name.   A file
  432.      name argument will be processed as though it were the input to the Set
  433.  
  434.  
  435.                                   Page 5
  436.  
  437.  
  438.                            RT Edit User's Manual
  439.  
  440.  
  441.      File Name command.  The purpose of the argument is not for startup
  442.      from Windows but for startup from an interactive development
  443.      environment, such as Microsoft's Visual C++ or Borland's C++.
  444.  
  445.      You may install RT Edit as a tool in either Visual C++ or in Borland
  446.      C++.  When you install a tool, you may identify an argument macro.
  447.      The macro is invoked when the tool is started.  In Visual C++, an
  448.      argument macro $File will pass the current source file name to RT
  449.      Edit.  In Borland C++, the macro $EDNAME will pass an argument with
  450.      the name of a file in a currently active editor.  So in either case,
  451.      you may set up RT Edit so you can move from editing in the environment
  452.      to editing in RT Edit.  If you start the tool when there is no source
  453.      or not an active edit window, the argument will be blank and RT Edit
  454.      will not set a file name.  If there is a file name set then Identifier
  455.      Lookup can be started immediately.  If you do, Identifier Lookup only
  456.      loads the identifiers in the current edit file but not header files.
  457.  
  458.   SetupRT
  459.  
  460.      Select File Name
  461.  
  462.        You must have at least one file name specified to use Identifier
  463.        Lookup.  Of course, you may use save and restore environment as
  464.        described below.  When you choose this menu item, you are prompted
  465.        through a common Windows dialog to set the file name.  This file
  466.        name should usually be the name of the file with a module in which
  467.        you want to add code.   For example, suppose you have a file,
  468.        "MODULE1.CPP":
  469.  
  470.           // File - MODULE1.CPP
  471.           #include "MOD1HDR.H"
  472.           ...
  473.           ...
  474.  
  475.        You would set up the file name to use MODULE1.CPP.  If you also
  476.        elect to include headers referenced in MODULE1.CPP (see below), the
  477.        identifiers loaded in for MODULE1.CPP will include any unique
  478.        identifiers also existing in "MOD1HDR.H."   The header file
  479.        "MOD1HDR.H" may also include other header files:
  480.  
  481.           // File - MOD1HDR.H
  482.           #include "MOD2HDR.H"
  483.           #include <window.h>    // Borland OWL( header
  484.           ....
  485.           ...
  486.  
  487.  
  488.      Select Header Options
  489.  
  490.        You need to decide whether header file names bracketed by "" in
  491.        #include statements in any file name entered in Set File Name
  492.        should also be scanned for identifiers.  If you decide to do so,
  493.        you are also prompted for whether you wish to also scan standard
  494.        library headers, that is, file names bracketed by <> in #include
  495.  
  496.  
  497.                                   Page 6
  498.  
  499.  
  500.                            RT Edit User's Manual
  501.  
  502.  
  503.        statements.  This menu item toggles.  If it is not checkmarked, it
  504.        will become checkmarked and you are prompted about the library
  505.        headers.
  506.  
  507.  
  508.      Select Source Directory
  509.  
  510.        If you do not run RT Edit in the directory where your source code
  511.        is, then choose this menu item and enter the path where your source
  512.        is  located.
  513.  
  514.      Select Header Directories
  515.  
  516.        Usually if you choose to use standard library headers, they will
  517.        exist in one or more directories other than the one holding your
  518.        source code.  Enter one or more paths separated by semi-colons.
  519.        This option is not required if no other directories need to be
  520.        searched for files other than either the current path or the source
  521.        directory entered above.
  522.  
  523.      Set Font
  524.  
  525.        You may change the font used to display your code in the edit
  526.        windows, but the font types must be fixed fonts.  The common dialog
  527.        for setting the font is controlled to show only fixed fonts.
  528.        Setting the font is optional.
  529.  
  530.      Initiate Identifier Lookup
  531.  
  532.        At this point you have completed enough setup to start the
  533.        Identifier Lookup.  Choose this menu item and wait until a new
  534.        window titled "Identifier Lookup" appears.  The more files and
  535.        identifiers to be loaded, the longer this will take.  The average
  536.        module with a few header files and 1000 unique names my take 10 to
  537.        15 seconds to load, depending on your system, of course.
  538.  
  539.      Save Environment
  540.  
  541.        After you see the new "Identifier Lookup" window, choose the Save
  542.        Environment menu item.  You may enter a file name if you do not
  543.        want to use the default name shown in the dialog.  The extension
  544.        used is *.dnv but you may change it.
  545.  
  546.      Select Edit File
  547.  
  548.        Open a file with File | Open.  Usually this will be one of the
  549.        files in your module that you intend to modify but actually it can
  550.        be any text file.
  551.  
  552.      Known Identifier Check
  553.  
  554.        Choose an insertion point in the open edit control and begin to
  555.        type an identifier name you know exists.   After typing four
  556.        characters of the name (assuming non-repeated characters), you
  557.  
  558.  
  559.                                   Page 7
  560.  
  561.  
  562.                            RT Edit User's Manual
  563.  
  564.  
  565.        should see that identifier displayed in the Identifier Lookup
  566.        window.   If necessary, scroll through the names with either of the
  567.        hot keys CTRL+< or CTRL+>.  When you see that identifier selected,
  568.        you can cause a substitution with the hot key combination CTRL+?..
  569.  
  570.      Terminate Identifier Lookup
  571.  
  572.        In order to observe the ability to get a quicker start than the
  573.        above procedure, you may want to try starting up with the
  574.        environment file you saved above.  One way to do this is to select
  575.        the menu item "Identifier Lookup", currently checkmarked because it
  576.        is active.  Identifier Lookup stops, the Identifier Lookup window
  577.        disappears and the menu item becomes unchecked.
  578.  
  579.      Restore Environment
  580.  
  581.        You may choose the menu item Restore Environment and select either
  582.        the default or enter the name used above in Save Environment.  You
  583.        may look under Help | About RT Edit to see the settings and file
  584.        names that have been restored from the environment file.
  585.  
  586.      Restart Identifier Lookup
  587.  
  588.        Restoring the environment does not initiate Identifier Lookup.
  589.        That is always under manual control.  Select the menu item
  590.        Identifier Lookup and the "Identifier Lookup" window will again be
  591.        displayed after a short load time.
  592.  
  593.   Test Edit
  594.  
  595.      Insert new variable name
  596.  
  597.        Enter a new variable name of more than four characters that you are
  598.        sure doesn't exist yet.   When the last character of the name is
  599.        typed, it is not yet stored by Identifier Lookup.  That will happen
  600.        when you type a non-identifier character or move off the identifier
  601.        with an arrow key
  602.  
  603.      Insert Known Variable name
  604.  
  605.        Type the same name created in the last step and verify as before
  606.        that the name is shown in the Identifier Lookup window.
  607.  
  608.  
  609.  
  610.  
  611.  
  612.  
  613.  
  614.  
  615.  
  616.  
  617.  
  618.  
  619.  
  620.  
  621.                                   Page 8
  622.  
  623.  
  624.                            RT Edit User's Manual
  625.  
  626.  
  627.  
  628. Alternative Setup
  629.  
  630.   Presented in the following are alternative ways to setup Identifier
  631.   Lookup operation.  The example files, repeated from the RT Edit
  632.   Operation section, are:
  633.  
  634.      // File - MODULE1.CPP
  635.      #include "MOD1HDR.H"
  636.      ...
  637.      ...
  638.      // File - MOD1HDR.H
  639.      #include "MOD2HDR.H"
  640.      #include <window.h>    // Borland OWL( header
  641.      ...
  642.      ...
  643.  
  644.   An alternative to naming a file and enabling headers is just to input
  645.   all the file names of interest and choose not to enable the Header
  646.   Options.  You could then use all of the three file names, MOD1HDR1.H,
  647.   MOD2HDR.H, and MODULE1.CPP, from the example given in RT Edit Operation
  648.   above.
  649.  
  650.   If you prefer to also include OWL identifiers in windows.h, you may
  651.   instead want to Set File Name to MOD1HDR.H in addition to the
  652.   MODULE1.CPP name entered above.  If you also elect to include all header
  653.   options, including library headers such the OWL header, then Identifier
  654.   Lookup will be loaded with all unique identifiers, for this example from
  655.   files "MODULE1.CPP", "MOD1HDR.H", "MOD2HDR.H", and "WINDOWS.H".
  656.  
  657.   Yet another way to get the identifiers from those same four files is to
  658.   simple use Set File Name to enter each file name.  In this case, it
  659.   isn't necessary to use any header options.  Upon Identifier Lookup
  660.   initiation, all the identifiers in those four files will be loaded.
  661.  
  662.   Finally, it is also possible to create a special file that includes as
  663.   many include statements as there are files you want to load.  You then
  664.   use Set File Name only for the special file.
  665.  
  666.  
  667.  
  668.  
  669.  
  670.  
  671.  
  672.  
  673.  
  674.  
  675.  
  676.  
  677.  
  678.  
  679.  
  680.  
  681.  
  682.  
  683.                                   Page 9
  684.  
  685.  
  686.                            RT Edit User's Manual
  687.  
  688.  
  689.  
  690. Identifier Searching Tactics
  691.  
  692.   You may need to know more about the factors affecting the appearance of
  693.   your identifiers in Identifier Lookup and in Expanded Search.   There
  694.   are tactics to apply in using either of these capabilities.
  695.  
  696.   Identifier Lookup will show you an existing identifier if you correctly
  697.   type at least the first or second character of the identifier.  The
  698.   correct character does not have to be in that position in what you type,
  699.   however.  It can be anywhere in the first four characters.  If you do
  700.   not have the correct first or second character, you may not see the
  701.   expected candidate match in the Identifier Lookup list at all.  In this
  702.   case, one alternative is to use Expanded Search, discussed below.
  703.   Another alternative, of course, is to look up the identifier yourself by
  704.   looking in the original source location where it was created.
  705.  
  706.   The situation may be that your candidate identifier is in the Identifier
  707.   Lookup list but the position in the list may be so far off that the list
  708.   is relatively useless to you.  This could definitely occur when you do
  709.   not have many of the letters correctly entered but may also occur if
  710.   there are a large number of similar identifiers.   You can of course
  711.   scan through the list with the hot keys and look for the identifier you
  712.   have in mind.  There may be a better way to handle the problem.
  713.  
  714.   If you know some root segment of your identifier, a better way to use
  715.   the Identifier Lookup may be to type in at least part of that segment.
  716.   This can improve the order in which RT Edit puts the candidates in the
  717.   Identifier Lookup list.
  718.  
  719.   Suppose you know there was an existing identifier you used that was
  720.   "modifiedHeaterPowerOnDuration."  Also suppose you typed "yzox."  The
  721.   "o" is one of the first two letters.  The rest are far off so it would
  722.   not be surprising that your identifier is way off in the list, assuming
  723.   there are many possible candidates in the list.  You could add or at
  724.   least start to add the letters for "Power", assuming that is a segment
  725.   that you recall is part of your identifier.  The matching done by
  726.   Identifier Lookup will likely be greatly improved.   Your target
  727.   identifier may then show as being automatically selected in the window.
  728.   If not, it may be shown at least in the window or not far down the list.
  729.  
  730.   Another factor to consider when entering quoted text is that you may not
  731.   want the words processed and displayed as candidate matches.  You can
  732.   suspend Identifier Lookup while you are typing the quoted string in this
  733.   case.  The initial scan will not process the words within quotes in any
  734.   case.
  735.  
  736.  
  737.  
  738.  
  739.  
  740.  
  741.  
  742.  
  743.  
  744.  
  745.                                   Page 10
  746.  
  747.  
  748.                            RT Edit User's Manual
  749.  
  750.  
  751.  
  752. RT Edit Help
  753.  
  754.   Introduction
  755.  
  756.      RT Edit is an editor with a spell-check dictionary based on your
  757.      source code and built-in headers.  This editor can  help you in draft
  758.      creation of new code or for adding  segments of code to a module.  The
  759.      way in which  RT Edit assists you is via a module called Identifier
  760.      Lookup. Identifier Lookup builds a dictionary of the  identifier names
  761.      you have already created or that  exist in library headers you intend
  762.      to use.  You may  turn Identifier Lookup ON or OFF or suspend it,
  763.      possibly an appropriate action when creating  comments.  While the
  764.      Identifier Lookup is ON, a  display indicates, under certain
  765.      conditions, your  C++  names.  You can select a name to be
  766.      substituted for the text you are typing.
  767.  
  768.      RT Edit has some capabilities in common with the Windows  Notepad
  769.      editor as incorporated into Borland Owl.  Please  see the specific
  770.      help for these functions under Files,  Edit,  Search, and Window.
  771.      Other capabilities are provided  through use of Borland's Owl.  One
  772.      feature dependent on  use of Borland's OWL is the toolbar, status line
  773.      and hint  available.  Control of these items is provided under the
  774.      View  menu.  Select a help section from the following:
  775.  
  776.        RT Edit Overview.
  777.        Identifier Lookup.
  778.        Use Headers On.
  779.        Set File Name.
  780.        Expanded Search
  781.        Suspend Lookup
  782.        Source Directory
  783.        Set Header Directories.
  784.        Set Font
  785.        Restore Environment.
  786.        Save Environment.
  787.        Auto Indent On
  788.  
  789.   SetupRT | Identifier Lookup
  790.  
  791.      Initiate Identifier Lookup operation anytime after at least one
  792.      source file name is identified through the Set File Name  menu
  793.      selection. If the menu selection is not checkmarked,  Identifier
  794.      Lookup may be initiated. Whenever it is checkmarked, Identifier Lookup
  795.      is active and selection will terminate Identifier Lookup. You should
  796.      not select Identifier Lookup on the "RT  Edit" menu unless you have
  797.      already named at least one file. If  you do,  you will see a
  798.      complaining message and startup of the  lookup function will not
  799.      proceed.  Another menu selection,  Restore Environment, would also
  800.      satisfy the need to have a file  name established.   During Identifier
  801.      Lookup initiation, a window  named "Identifier Lookup" is created.
  802.      This window, if selected  to be the active window, will ignore client
  803.      window keyboard and  mouse input.  You should not select the
  804.  
  805.  
  806.  
  807.                                   Page 11
  808.  
  809.  
  810.                            RT Edit User's Manual
  811.  
  812.  
  813.      Identifier Lookup  window unless you wish to change it's size and
  814.      location.
  815.  
  816.   SetupRT | Set File Name
  817.  
  818.      Use the menu choice "Set File Name" to identify your primary  source
  819.      file.  You may also want to use this setting to name one  or more
  820.      header files that are part of the module.
  821.  
  822.   SetupRT | Use Headers On
  823.  
  824.      Click on the menu item to toggle the state of Use Headers On.  When
  825.      setting the state on, you will be asked if you wish to use  library
  826.      files.  If you say Yes to using library files, it may be  appropriate
  827.      to set directory names with Set Header Directories.
  828.  
  829.   SetupRT | Expanded Search
  830.  
  831.      Expanded Search looks up candidate identifiers by a  different method
  832.      than used in Identifier Lookup. Type a  segment of an Identifier you
  833.      want to find with Expanded  Search, then choose the Expanded Search
  834.      menu item or  press the hot key combination, alt-x.  The letters you
  835.      have  typed so far will appear in a dialog and you have the option of
  836.      changing or adding letters to the segment.  You then may  select OK in
  837.      the dialog to continue or CANCEL.  If you  selected OK,  another
  838.      dialog will list all identifiers in groups  sorted by the number of
  839.      characters containing the same  characters as the segment you created.
  840.      You may select an  identifier and choose REPLACE or you may CANCEL.
  841.      Choosing REPLACE will replace the segment you typed so  far even if
  842.      you changed it in the search dialog.  The  substitution will occur in
  843.      the same manner as for Identifier  Lookup except that only one
  844.      character of the identifier must  be typed.  An attempt to use
  845.      Expanded Search with no  characters typed will cause a warning message
  846.      to be  displayed.  Generally speaking, you should use several
  847.      characters for the search to obtain a reasonable result.
  848.  
  849.   SetupRT | Suspend Lookup
  850.  
  851.      You may select this menu item at any time Identifier Lookup is
  852.      active.  The state of Identifier Lookup will be toggled between
  853.      suspended (checkmark displayed by the Suspend Lookup  menu item) and
  854.      not suspended (no checkmark).  You may  want to suspend Identifier
  855.      Lookup when you are editing within  "/*" and "*/" begin/end comment
  856.      marks.  The words within  these comment marks were not saved by
  857.      Identifier Lookup  when starting up.  However, words typed within
  858.      these  comments while editing are treated as identifiers unless you
  859.      use Suspend Lookup.
  860.  
  861.   SetupRT | Source Directory
  862.  
  863.      If your source files are not in the current directory, you may  enter
  864.      that directory via this menu item. Enter multiple paths on  the input
  865.      line provided by separating them with a semicolon (;).
  866.  
  867.  
  868.  
  869.                                   Page 12
  870.  
  871.  
  872.                            RT Edit User's Manual
  873.  
  874.  
  875.   SetupRT | Header Directories
  876.  
  877.      Directories to be searched for include files, other than the  current
  878.      directory, should be set with this command.  Enter  multiple paths on
  879.      the input line provided by separating them  with a semicolon (;).
  880.  
  881.   SetupRT | Set Font
  882.  
  883.      You may change the font being used, but note that use of  Identifier
  884.      Lookup depends on using fixed fonts.  The fonts  presented in the
  885.      dialog box are limited to fixed fonts.
  886.  
  887.   SetupRT | Restore Environment
  888.  
  889.      Select the RT Edit menu item "Restore Environment" to restore  the
  890.      initialization of Identifier Lookup to a previously saved
  891.      environment, that is, an environment saved with Save  Environment.
  892.  
  893.   SetupRT | Save Environment
  894.  
  895.      Save the current environment in a file for use during a  subsequent
  896.      session.  The following elements are saved:
  897.  
  898.        File names that have been entered with Set File Name.
  899.  
  900.        File names referenced in "#include" statements within  the files
  901.        named above, if "Use Header Directories" was set during the Use
  902.        Headers On dialog.
  903.  
  904.   SetupRT | Auto Indent On
  905.  
  906.      You  may choose to have auto indent on or off.  When Auto  Indent is
  907.      on, the menu item is checked.  With Auto Indent,  the cursor position
  908.      is adjusted after a carriage return is  entered. An adjustment is made
  909.      also if a backspace is  entered and there is nothing on the line
  910.      except whitespace  prior to the current line position.  A scan of
  911.      lines before the  current cursor position is performed for either a
  912.      carriage  return or a backspace.  The scan of a line finds the
  913.      position  of the first non-whitespace character on the line.  If a
  914.      non-whitespace character is not found, the position is set to  the end
  915.      of the line.  Only one previous line is scanned if a  carriage return
  916.      is entered.  The cursor position on the new  line is set to the same
  917.      position found in the scan, filling the  line to that point with an
  918.      appropriate number of tabs and  spaces.
  919.  
  920.  
  921.      The first previous line is scanned if a backspace is entered  as well.
  922.      If the position found in the scan is at the beginning  of the line
  923.      anyway, no further processing is done and the  whitespace at the
  924.      beginning of the line will be removed,  positioning non-whitespace
  925.      text, if there is any, at the  beginning of the line.   The current
  926.      position on the line is  adjusted to the same position found on the
  927.      scan of the  previous line if that position is farther to the left.
  928.      Whitespace  is also removed as needed.  If the scan of the previous
  929.  
  930.  
  931.                                   Page 13
  932.  
  933.  
  934.                            RT Edit User's Manual
  935.  
  936.  
  937.      line  is not to the left of the current position, scanning is
  938.      continued  on previous lines from closest to the first line, until a
  939.      position  to the left of the current position is found.  The default,
  940.      if   such a position is not found, is to backspace one character
  941.      position.
  942.  
  943.  
  944.  
  945.  
  946.  
  947.  
  948.  
  949.  
  950.  
  951.  
  952.  
  953.  
  954.  
  955.  
  956.  
  957.  
  958.  
  959.  
  960.  
  961.  
  962.  
  963.  
  964.  
  965.  
  966.  
  967.  
  968.  
  969.  
  970.  
  971.  
  972.  
  973.  
  974.  
  975.  
  976.  
  977.  
  978.  
  979.  
  980.  
  981.  
  982.  
  983.  
  984.  
  985.  
  986.  
  987.  
  988.  
  989.  
  990.  
  991.  
  992.  
  993.                                   Page 14
  994.  
  995.  
  996.                            RT Edit User's Manual
  997.  
  998.  
  999.  
  1000. Shareware
  1001.  
  1002.   Shareware distribution gives users a chance to try software before
  1003.   buying it. If you try a Shareware program and continue using it, you are
  1004.   expected to register. Individual programs differ on details -- some
  1005.   request registration while others require it, some specify a maximum
  1006.   trial period. With registration, you get anything from the simple right
  1007.   to continue using the software to an updated program with printed
  1008.   manual.
  1009.  
  1010.   Copyright laws apply to both Shareware and commercial software,  and the
  1011.   copyright holder retains all rights, with a few specific exceptions as
  1012.   stated below. Shareware authors are accomplished programmers, just like
  1013.   commercial authors, and the programs are of comparable quality. (In both
  1014.   cases, there are good programs and bad ones!) The main difference is in
  1015.   the method of distribution. The author specifically grants the right to
  1016.   copy and distribute the software, either to all and sundry or to a
  1017.   specific group. For example, some authors require written permission
  1018.   before a commercial disk vendor may copy their Shareware.
  1019.  
  1020.   Shareware is a distribution method, not a type of software. You should
  1021.   find software that suits your needs and pocketbook,  whether it's
  1022.   commercial or Shareware. The Shareware system makes fitting your needs
  1023.   easier, because you can try before you buy.  Because the overhead is
  1024.   low, prices are low also. Shareware has the ultimate money-back
  1025.   guarantee -- if you don't use the product, you don't pay for it.
  1026.  
  1027.  
  1028.  
  1029.  
  1030.  
  1031.  
  1032.  
  1033.  
  1034.  
  1035.  
  1036.  
  1037.  
  1038.  
  1039.  
  1040.  
  1041.  
  1042.  
  1043.  
  1044.  
  1045.  
  1046.  
  1047.  
  1048.  
  1049.  
  1050.  
  1051.  
  1052.  
  1053.  
  1054.  
  1055.                                   Page 15
  1056.  
  1057.  
  1058.                            RT Edit User's Manual
  1059.  
  1060.  
  1061.  
  1062. Support
  1063.  
  1064.   You may obtain technical support for RT Edit for at least a period of 3
  1065.   months following the date of your registration.  You may send mail
  1066.   describing your request for support to:
  1067.  
  1068.      MLK Software
  1069.      1030 E. El Camino Real, #141
  1070.      Sunnyvale CA 94087
  1071.  
  1072.   Or you may call:
  1073.  
  1074.      (408) 243-4808
  1075.      Answering machine -- Leave name and telephone number for a reply
  1076.  
  1077.   The file "SUPPORT.TXT" is provided with distribution of the software.
  1078.   This file contains additional information about the current support
  1079.   levels provided.
  1080.  
  1081.  
  1082.  
  1083.  
  1084. ASP Ombudsman
  1085.  
  1086.   This program is produced by MLK Software, a member of the Association of
  1087.   Shareware Professionals (ASP).  ASP wants to make sure that the
  1088.   shareware principle works for you. If you are unable to resolve a
  1089.   shareware-related problem with an ASP member by contacting the member
  1090.   directly, ASP may be able to help. The ASP Ombudsman can help you
  1091.   resolve a dispute or problem with an ASP member, but does not provide
  1092.   technical support for members' products.  Please write to the ASP
  1093.   Ombudsman at 545 Grover Road, Muskegon, MI 49442-9427 USA, FAX  616-788-
  1094.   2765 or send a CompuServe message via CompuServe Mail to ASP Ombudsman
  1095.   70007,3536.
  1096.  
  1097.  
  1098.  
  1099.  
  1100.  
  1101.  
  1102.  
  1103.  
  1104.  
  1105.  
  1106.  
  1107.  
  1108.  
  1109.  
  1110.  
  1111.  
  1112.  
  1113.  
  1114.  
  1115.  
  1116.  
  1117.                                   Page 16
  1118.  
  1119.  
  1120.                            RT Edit User's Manual
  1121.  
  1122.  
  1123.  
  1124. License, Warranty and Registration
  1125.  
  1126.   Users of RT Edit must accept this disclaimer of warranty:  "RT Edit is
  1127.   supplied as is.  The author disclaims all warranties, expressed or
  1128.   implied, including, without limitation,  the warranties of
  1129.   merchantability and of fitness for any purpose.  The author assumes no
  1130.   liability for damages, direct or consequential,  which may result from
  1131.   the use of RT Edit."
  1132.  
  1133.   RT Edit is a "shareware program" and is provided at no charge to the
  1134.   user for evaluation.  Feel free to share it with your friends, but
  1135.   please do not give it away altered or as part of another system.  The
  1136.   essence of "user-supported" software is to provide personal computer
  1137.   users with quality software without high prices, and yet to provide
  1138.   incentive for programmers to continue to develop new products.  If you
  1139.   find this program useful and find that you are using RT Edit and
  1140.   continue to use RT Edit after a 60 day trial period, you must make a
  1141.   registration-payment to MLK Software. Please see the accompanying files
  1142.   distributed with the program, "REGISTER.TXT"  and "REGISTER.FRM," for
  1143.   registration information and an order form respectively.
  1144.  
  1145.   The registration fee will license one copy for use on any one computer
  1146.   at any one time.  You must treat this software just like a book.  An
  1147.   example is that this software may be used by any number of people and
  1148.   may be freely moved from one computer location to another, so long as
  1149.   there is no possibility of it being used at one location while it's
  1150.   being used at another, just as a book cannot be read by two different
  1151.   persons at the same time.
  1152.  
  1153.   Commercial users of RT Edit must register and pay for their copies of RT
  1154.   Edit within 60 days of first use or their license is withdrawn.  Site-
  1155.   License arrangements may be made by contacting MLK Software.
  1156.  
  1157.   Anyone distributing RT Edit for any kind of remuneration must first
  1158.   contact MLK Software at the address above (see Support) for
  1159.   authorization.  This authorization will be automatically granted to
  1160.   distributors recognized by the (ASP) as adhering to its guidelines for
  1161.   shareware distributors, and such distributors may begin offering RT Edit
  1162.   immediately (However MLK Software must still be advised so that the
  1163.   distributor can be kept up-to-date with the latest version of RT Edit.).
  1164.   You are encouraged to pass a copy of RT Edit along to your friends for
  1165.   evaluation.  Please encourage them to register their copy if they find
  1166.   that they can use it.  All registered users will receive a copy of the
  1167.   latest version of RT Edit (3 1/2" diskette) and a printed manual.
  1168.  
  1169.  
  1170.  
  1171.  
  1172.  
  1173.  
  1174.  
  1175.  
  1176.  
  1177.  
  1178.  
  1179.                                   Page 17
  1180.